/*
 *  Copyright 2007 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.action.core.sequence;

import com.blandware.atleap.common.Constants;
import com.blandware.atleap.model.core.ActionPage;
import com.blandware.atleap.model.core.ContentPage;
import com.blandware.atleap.model.core.Layout;
import com.blandware.atleap.model.core.Localizable;
import com.blandware.atleap.model.core.Sequence;
import com.blandware.atleap.service.core.SequenceManager;
import com.blandware.atleap.webapp.action.core.BaseAction;
import com.blandware.atleap.webapp.form.core.SequenceForm;
import com.blandware.atleap.webapp.util.core.WebappConstants;
import com.blandware.atleap.webapp.util.core.WebappUtil;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Set;

/**
 * <p>Exposes bean to request to view its properties on JSP page (sequence
 * is to be viewed)
 * </p>
 * <p><a href="ViewSequenceAction.java.html"><i>View Source</i></a></p>
 * <p/>
 *
 * @author Roman Puchkovskiy <a href="mailto:roman.puchkovskiy@blandware.com">
 *         &lt;roman.puchkovskiy@blandware.com&gt;</a>
 * @version : $Revision: 1.4 $ : 2007/12/17 13:38:25 $
 * @struts.action path="/core/sequence/view"
 * name="sequenceForm"
 * scope="request"
 * validate="false"
 * roles="core-sequence-view"
 * @struts.action-forward name="viewSequence"
 * path=".core.sequence.view"
 * @struts.action-forward name="listSequences"
 * path="/core/sequence/list.do"
 * redirect="false"
 */
public final class ViewSequenceAction extends BaseAction {
	/**
	 * @param mapping  The ActionMapping used to select this instance
	 * @param form     The optional ActionForm bean for this request (if any)
	 * @param request  The HTTP request we are proceeding
	 * @param response The HTTP response we are creating
	 * @return an ActionForward instance describing where and how
	 *         control should be forwarded, or null if response
	 *         has already been completed
	 */
	public ActionForward execute(ActionMapping mapping, ActionForm form,
	                             HttpServletRequest request, HttpServletResponse response) throws Exception {

		SequenceForm sequenceForm = (SequenceForm) form;

		Long sequenceId;
		if ( !GenericValidator.isBlankOrNull(sequenceForm.getId()) ) {
			sequenceId = Long.valueOf(sequenceForm.getId());
		} else if ( request.getSession().getAttribute(WebappConstants.SEQUENCE_ID_KEY) != null ) {
			sequenceId = (Long) request.getSession().getAttribute(WebappConstants.SEQUENCE_ID_KEY);
		} else {
			Long ownerId;
			if ( sequenceForm.getOwnerId() != null && sequenceForm.getOwnerId().length() > 0 ) {
				ownerId = Long.valueOf(sequenceForm.getOwnerId());
			} else {
				if ( log.isWarnEnabled() ) {
					log.warn("Missing owner ID. Returning to index...");
				}
				return mapping.findForward("admin");
			}

			request.getSession().setAttribute(WebappConstants.OWNER_ID_KEY, ownerId);

			if ( log.isWarnEnabled() ) {
				log.warn("Missing sequence ID. Returning to list...");
			}

			return mapping.findForward("listSequences");
		}

        request.getSession().setAttribute(WebappConstants.SEQUENCE_ID_KEY, sequenceId);

        SequenceManager sequenceManager = (SequenceManager) getBean(Constants.SEQUENCE_MANAGER_BEAN);
		Sequence sequence = sequenceManager.retrieveSequence(sequenceId);
		if ( sequence == null ) {
			// sequence not found. it might be deleted by someone else
			ActionMessages errors = new ActionMessages();
			errors.add("sequenceNotFound", new ActionMessage("core.sequence.errors.notFound"));
			saveErrors(request, errors);
			return mapping.findForward("listSequences");
		}

		String sequenceIdentifier = sequence.getIdentifier();

		request.setAttribute("sequence", sequence);

		// get information about owner
		Localizable owner = sequence.getOwner();
		String ownerInfo = WebappUtil.getLocalizableInfo(owner, request);
		request.getSession().setAttribute(WebappConstants.OWNER_INFO_KEY, ownerInfo);

		boolean canUpdateSequence = request.isUserInRole("core-sequence-update");
        boolean canUpdateOverridenSequence = request.isUserInRole("core-sequence-updateOverriden");

        Set identifiers = WebappUtil.getOverridableSequenceIdentifiers(owner, request);
        boolean overridenSequence = identifiers.contains(sequenceIdentifier);

		if ( canUpdateSequence
                || (owner instanceof ContentPage && canUpdateOverridenSequence)
                || (owner instanceof ActionPage && canUpdateOverridenSequence && overridenSequence)
                || (owner instanceof Layout && (canUpdateOverridenSequence && overridenSequence)) ) {
			request.setAttribute("updateAllowed", "true");
		}

        saveToken(request);
		return mapping.findForward("viewSequence");
	}
}